# InBox TFSIntegration

Versão 6.2.2 Data de Criação 29/05/2019

# Recursos

Três scripts para atendente genérico e um webhook:

• Criação de WorkItem;
• Atualização de WorkItem;
• Atualização de descrição do WorkItem;
• Atualização de estados no TFS;

# Pré-requisitos

# Framework

As seguintes versões de framework OTRS são suportadas:

• [6.x.x]

# Módulos

Os seguintes módulos são requeridos:

• InBox Core 6.6.0 ou superior

# Sistema Operacional

Os seguintes sistemas operacionais são requeridos:

• [Nenhum]

# Software de Terceiros

Os seguintes softwares de terceiros são requeridos:

• [Nenhum]

# Instalação

bin/otrs.Console.pl Admin::Package::Install /path/to/InBox\ TFSIntegration-6.2.2.opm

# Configuração

Este módulo possui as seguintes configurações:

# InBox::Integration::TFS::ExternalID

Mapeamento do campo dinâmico referente ao WorkItemID no OTRS e no TFS, Exemplo:

Sendo que a chave deverá conter o nome do campo dinâmico no OTRS e o valor deverá conter o nome do campo dinâmico do TFS.

# InBox::Integration::TFS::DynamicFieldsMapping

Mapeamento dos campos dinâmicos do OTRS no TFS, Exemplo:

Sendo que a chave deverá conter o nome do campo dinâmico no OTRS e o valor deverá conter o nome do campo dinâmico do TFS.

# InBox::Integration::TFS::StatesMapping

Mapeamento de estados do TFS no OTRS, Exemplo:

Sendo que a chave deverá conter o nome do estado no TFS e o valor deverá conter o nome do estado no OTRS.

# InBox::Integration::TFS::EnablePriority

Habilita o envio da prioridade do OTRS para o TFS, sendo que será resgatado apenas o nº da prioridade.

Valor Padrão: Desabilitado

# InBox::Integration::TFS::url

Url para requisição, exemplo: https://dev.azure.com/exemple/.

# InBox::Integration::TFS::StateToWI

Indica o estado em que o workitem será criado no TFS:

# Uso

# Atendente genérico para criação do WorkItem

Em administração procure pelo módulo "Atendente Genérico":

Ao entar no módulo cique em "Adicionar Job":

Como exemplo, será criado um atendente genérico que será disparado quando o chamado estiver na fila "Misc":

Os parâmetros que serão aceitos serão estes:

• Módulo:

    O caminho em que se encontra o script.
    Valor padrão: Kernel::System::GenericAgent::TFSIntegrationCreationWI
  

• Work_Item_Type:

   Tipo de WorkItem do TFS, exemplo: product backlog item, bug , etc...
  

• api_version:

   Versão da api do TFS, sendo possível alterá-la entre a versão 4.1 e 5.0 .
  

• ProjectName:

   Nome do projeto em que o WorkItem será aberto, sendo necessário ter o nome igual ao TFS.
  

• Collection:

   O nome da collection do projeto.
  

• Area&InterationPath:

   Os parametros de Area e InterationPath no TFS, sendo que eles devem ser separados por ponto e vírgula ";", sendo primeiro o Area e depois o InterationPath.
  

Quando o chamado sofrer alteração de fila um novo WorkItem será criado e ficará desta forma:

Sendo que a descrição no TFS irá receber o título, data de criação e corpo dos artigos criados no chamado.

# Atendente genérico para update no WorkItem

Em administração procure pelo módulo "Atendente Genérico":

Ao entar no módulo cique em "Adicionar Job":

Como exemplo, será criado um atendente genérico que será disparado quando o campo dinâmico "Nome" for alterado:

Os parâmetros que serão aceitos serão estes:

• Módulo:

    O caminho em que se encontra o script.
    Valor padrão: Kernel::System::GenericAgent::TFSIntegrationUpdateWI
  

• Work_Item_type:

   Tipo de WorkItem do TFS, exemplo: product backlog item, bug , etc...
  

• api_version:

   Versão da api do TFS, sendo possível alterá-la entre a versão 4.1 e 5.0 .
  

• ProjectName:

   Nome do projeto em que o WorkItem será aberto, sendo necessário ter o nome igual ao TFS.
  

• Collection:

   O nome da collection do projeto.
  

Caso o atendente genérico seja executado, pegando todos os campos da configuração InBox::Integration::TFS::DynamicFieldsMapping e atualizando estes valores no TFS.

# Atendente genérico para update de Descrição do WorkItem

Em administração procure pelo módulo "Atendente Genérico":

Ao entar no módulo cique em "Adicionar Job":

Como exemplo, será criado um atendente genérico que será disparado quando um artigo for criado:

Os parâmetros que serão aceitos serão estes:

• Módulo:

    O caminho em que se encontra o script.
    Valor padrão: Kernel::System::GenericAgent::TFSIntegrationUpdateWI
  

• Work_Item_type:

   Tipo de WorkItem do TFS, exemplo: product backlog item, bug , etc...
  

• api_version:

   Versão da api do TFS, sendo possível alterá-la entre a versão 4.1 e 5.0 .
  

• ProjectName:

   Nome do projeto em que o WorkItem será aberto, sendo necessário ter o nome igual ao TFS.
  

• Collection:

   O nome da collection do projeto.
  

Caso o atendente genérico seja executado e o artigo criado seja um artigo do tipo "Internal", o título, corpo e data de criação do artigo, será adicionados a descrição do WorkItem.

# WebHook para alteração de estados

Em administração procure pelo módulo "Web Services":

A configuração dele deve estar da seguinte forma:

A seguinte url receberá os dados do TFS:

http://seudominio.com/otrs/nph-genericinterface.pl/Webservice/GenericInfoRecceiverREST/ReceiveTFS?UserLogin=LoginAtendenteAdmin&Password=teste